9999: Generate Demo Dataset

Scenario #9999: Generate Demo Dataset

Create the mandant person Hostsharing eG

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG"
}
EOF
=> status: 201 CREATED 34d96c31-7002-41a6-83b4-08898defecd3

Creating accounts needs an acting global-admin USER subject, but that subject does not need to have an own account (and thus a person) itself. Here, such a subject gets created: it is synchronized from Keycloak, and the global ADMIN role is granted to it, but no account is created for it.

Properties

Given

name	value
subjectUuid	de300000-0000-0000-0000-000000000001
subjectName	hsh-demo_admin

Synchronize the new USER Subject from Keycloak

HTTP PUT "/api/rbac/subjects/de300000-0000-0000-0000-000000000001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "name" : "hsh-demo_admin",
  "type" : "USER"
}
EOF
=> status: 201 CREATED de300000-0000-0000-0000-000000000001

This is what the Keycloak sync program does for each new Keycloak user.

Prerequisite: Resolve the UUID of the global ADMIN role

The grant API needs the UUID of the role which we want to grant.

HTTP GET "/api/rbac/roles?name=rbac.global%23global%3AADMIN" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "8b462bd2-e8aa-4f65-aff3-607fcb17402b",
  "object.uuid" : "d7dc39b7-72a1-420d-9e1b-c91d01ca2071",
  "objectTable" : "rbac.global",
  "objectIdName" : "global",
  "roleType" : "ADMIN",
  "roleName" : "rbac.global#d7dc39b7-72a1-420d-9e1b-c91d01ca2071:ADMIN",
  "roleIdName" : "rbac.global#global:ADMIN"
} ]

Grant the global ADMIN role to the new USER Subject

HTTP POST "/api/rbac/grants" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  -H 'Hostsharing-Assumed-Roles: rbac.global#global:ADMIN' \
  <<EOF
{
  "assumed" : true,
  "grantedRole.uuid" : "8b462bd2-e8aa-4f65-aff3-607fcb17402b", // globalAdminRoleUuidToGrant
  "granteeSubject.uuid" : "de300000-0000-0000-0000-000000000001"
}
EOF
=> status: 201 CREATED 8b462bd2-e8aa-4f65-aff3-607fcb17402b // globalAdminRoleUuidToGrant

Verify the new global-admin Subject does not have an own Account

HTTP GET "/api/hs/accounts/current" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-demo_admin>"` \
  `# }`
=> status: 200 OK 
{
  "subject" : {
    "uuid" : "de300000-0000-0000-0000-000000000001",
    "name" : "hsh-demo_admin",
    "organization" : "hsh",
    "type" : "USER"
  },
  "person" : null,
  "globalAdmin" : true
}

UseCase Create Partner => Partner: P-90000 - Tannenhof Bürotechnik eG

Properties

Given

name	value
partnerNumber	P-90000
personType	LEGAL_PERSON
contactCaption	Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
postalAddress	“street”: “Am Anger 167”, “zipcode”: “86150”, “city”: “Augsburg”, “country”: “Germany”
officePhoneNumber	+49 171 3920080
emailAddress	info@tannenhof-buerotechnik-eg.example.org
tradeName	Tannenhof Bürotechnik eG
registrationOffice	Registergericht Augsburg
registrationNumber	555465

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3",
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Tannenhof Bürotechnik eG"
}
EOF
=> status: 201 CREATED eced4afc-0085-4561-b74c-47e3aba0313d

Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
  "postalAddress" : {
    "street" : "Am Anger 167",
    "zipcode" : "86150",
    "city" : "Augsburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920080"
  },
  "emailAddresses" : {
    "main" : "info@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED c94cc771-699e-4b18-a2e5-17c7307d66c8

Create Partner: P-90000 - Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90000",
  "partnerRel" : {
    "anchor.uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "holder.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "contact.uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8" // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
  },
  "details" : {
    "registrationOffice" : "Registergericht Augsburg",
    "registrationNumber" : "555465"
  }
}
EOF
=> status: 201 CREATED 5809a309-c582-4b08-b9a0-62236aa95d13

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Tannenhof+B%C3%BCrotechnik+eG+-+Hauptkontakt+%28P-90000%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
  "anchor" : {
    "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
    "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
    "postalAddress" : {
      "zipcode" : "86150",
      "country" : "Germany",
      "city" : "Augsburg",
      "street" : "Am Anger 167"
    },
    "emailAddresses" : {
      "main" : "info@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920080"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Torsten Schneider - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - Vertretung (P-90000)
postalAddress	“name”: “Geschäftsführung”, “street”: “Wiesengrund 246”, “zipcode”: “50667”, “city”: “Köln”, “country”: “Germany”
phoneNumber	+49 221 4710870
emailAddress	torsten-schneider@tannenhof-buerotechnik-eg.example.org

Person: Torsten Schneider

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schneider",
  "givenName" : "Torsten"
}
EOF
=> status: 201 CREATED 49a3077b-c664-4d90-9c90-12e6e6055eeb

Contact: Torsten Schneider - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Torsten Schneider - Vertretung (P-90000)",
  "postalAddress" : {
    "name" : "Geschäftsführung",
    "street" : "Wiesengrund 246",
    "zipcode" : "50667",
    "city" : "Köln",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 221 4710870"
  },
  "emailAddresses" : {
    "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 872a30c2-49c8-45e8-acd3-31db37a1571d

Create REPRESENTATIVE: Torsten Schneider - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
  "contact.uuid" : "872a30c2-49c8-45e8-acd3-31db37a1571d" // Contact: Torsten Schneider - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED a4223821-5e7b-40af-9670-68b664532ef1

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/a4223821-5e7b-40af-9670-68b664532ef1" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a4223821-5e7b-40af-9670-68b664532ef1",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "872a30c2-49c8-45e8-acd3-31db37a1571d", // Contact: Torsten Schneider - Vertretung (P-90000)
    "caption" : "Torsten Schneider - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Wiesengrund 246",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710870"
    }
  }
}

UseCase Add Demo Relation => REPRESENTATIVE: Susanne Weber - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - Vertretung (P-90000)
postalAddress	“street”: “Ulmenstraße 729”, “zipcode”: “44135”, “city”: “Dortmund”, “country”: “Germany”
phoneNumber	+49 171 3920066
emailAddress	susanne-weber@tannenhof-buerotechnik-eg.example.org

Person: Susanne Weber

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Weber",
  "givenName" : "Susanne"
}
EOF
=> status: 201 CREATED 8c9dc579-5897-46ad-b034-55e9fbb48d29

Contact: Susanne Weber - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Susanne Weber - Vertretung (P-90000)",
  "postalAddress" : {
    "street" : "Ulmenstraße 729",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920066"
  },
  "emailAddresses" : {
    "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED b689044a-5929-4868-86f0-e5fbe944521d

Create REPRESENTATIVE: Susanne Weber - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "8c9dc579-5897-46ad-b034-55e9fbb48d29", // Person: Susanne Weber
  "contact.uuid" : "b689044a-5929-4868-86f0-e5fbe944521d" // Contact: Susanne Weber - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED dd37ab33-2bf5-4df6-9bed-b92b9d82a4c7

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/dd37ab33-2bf5-4df6-9bed-b92b9d82a4c7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "dd37ab33-2bf5-4df6-9bed-b92b9d82a4c7",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "8c9dc579-5897-46ad-b034-55e9fbb48d29", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "b689044a-5929-4868-86f0-e5fbe944521d", // Contact: Susanne Weber - Vertretung (P-90000)
    "caption" : "Susanne Weber - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Ulmenstraße 729"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920066"
    }
  }
}

UseCase Add Demo Relation => REPRESENTATIVE: Claudia Großbaum - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Claudia
holderFamilyName	Großbaum
contactCaption	Claudia Großbaum - Vertretung (P-90000)
postalAddress	“street”: “Am Anger 731”, “zipcode”: “20095”, “city”: “Hamburg”, “country”: “Germany”
phoneNumber	+49 40 66969668
emailAddress	claudia-grossbaum@tannenhof-buerotechnik-eg.example.org

Person: Claudia Großbaum

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Großbaum",
  "givenName" : "Claudia"
}
EOF
=> status: 201 CREATED 38b4be23-e557-4eed-8ca6-b6d6cf6e0501

Contact: Claudia Großbaum - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Claudia Großbaum - Vertretung (P-90000)",
  "postalAddress" : {
    "street" : "Am Anger 731",
    "zipcode" : "20095",
    "city" : "Hamburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 40 66969668"
  },
  "emailAddresses" : {
    "main" : "claudia-grossbaum@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED ff8b0141-312f-4629-ac8d-cf1a07542531

Create REPRESENTATIVE: Claudia Großbaum - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "38b4be23-e557-4eed-8ca6-b6d6cf6e0501", // Person: Claudia Großbaum
  "contact.uuid" : "ff8b0141-312f-4629-ac8d-cf1a07542531" // Contact: Claudia Großbaum - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 048b2b7b-5f7f-4b5d-a3d7-fd4c1fa33611

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/048b2b7b-5f7f-4b5d-a3d7-fd4c1fa33611" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "048b2b7b-5f7f-4b5d-a3d7-fd4c1fa33611",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "38b4be23-e557-4eed-8ca6-b6d6cf6e0501", // Person: Claudia Großbaum
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Claudia",
    "familyName" : "Großbaum"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "ff8b0141-312f-4629-ac8d-cf1a07542531", // Contact: Claudia Großbaum - Vertretung (P-90000)
    "caption" : "Claudia Großbaum - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "20095",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "Am Anger 731"
    },
    "emailAddresses" : {
      "main" : "claudia-grossbaum@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 66969668"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aaa
bankAccountHolder	Tannenhof Bürotechnik eG (P-90000/0)
iban	DE15990200000838881174
bic	DEMVDEH0
billingContactCaption	Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
billingContactEmailAddress	rechnung0@tannenhof-buerotechnik-eg.example.org

BankAccount: Tannenhof Bürotechnik eG (P-90000/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
  "iban" : "DE15990200000838881174",
  "bic" : "DEMVDEH0"
}
EOF
=> status: 201 CREATED 74a70903-dda0-4ff5-87cd-594134baa51e

Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
  "emailAddresses" : {
    "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED f14d56ab-f975-4256-8881-e14543323c69

Create Debitor: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "holder.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "contact.uuid" : "f14d56ab-f975-4256-8881-e14543323c69" // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "74a70903-dda0-4ff5-87cd-594134baa51e", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
  "defaultPrefix" : "aaa"
}
EOF
=> status: 201 CREATED ecc5c988-34fb-48ad-a5d6-6d0793a052aa

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/ecc5c988-34fb-48ad-a5d6-6d0793a052aa" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ecc5c988-34fb-48ad-a5d6-6d0793a052aa",
  "debitorRel" : {
    "uuid" : "866a888e-4008-4992-af28-76063ea1c57b",
    "anchor" : {
      "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "f14d56ab-f975-4256-8881-e14543323c69", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
      "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000000",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13",
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "74a70903-dda0-4ff5-87cd-594134baa51e", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
    "iban" : "DE15990200000838881174",
    "bic" : "DEMVDEH0"
  },
  "defaultPrefix" : "aaa"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000000-aktuell

Properties

Given

name	value
debitorNumber	D-9000000
mandateReference	D-9000000-aktuell
bankAccountHolder	Tannenhof Bürotechnik eG (P-90000/0/aktuell)
iban	DE86990200000766401011
bic	DEMVDEH0
agreement	2023-03-05
validFrom	2023-03-08

Debitor of D-9000000-aktuell

HTTP GET "/api/hs/office/debitors/D-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ecc5c988-34fb-48ad-a5d6-6d0793a052aa",
  "debitorRel" : {
    "uuid" : "866a888e-4008-4992-af28-76063ea1c57b",
    "anchor" : {
      "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "f14d56ab-f975-4256-8881-e14543323c69", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
      "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000000",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13",
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "74a70903-dda0-4ff5-87cd-594134baa51e", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
    "iban" : "DE15990200000838881174",
    "bic" : "DEMVDEH0"
  },
  "defaultPrefix" : "aaa"
}

BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Tannenhof Bürotechnik eG (P-90000/0/aktuell)",
  "iban" : "DE86990200000766401011",
  "bic" : "DEMVDEH0"
}
EOF
=> status: 201 CREATED 146a976d-aa6d-42ea-ad3b-aa1babdf8037

Create SEPA-Mandat: D-9000000-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "ecc5c988-34fb-48ad-a5d6-6d0793a052aa", // Debitor of D-9000000-aktuell
  "bankAccount.uuid" : "146a976d-aa6d-42ea-ad3b-aa1babdf8037", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)
  "reference" : "D-9000000-aktuell",
  "agreement" : "2023-03-05",
  "validFrom" : "2023-03-08"
}
EOF
=> status: 201 CREATED 4e11880c-bed0-430c-b23f-fa4f1a9a39f7

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/4e11880c-bed0-430c-b23f-fa4f1a9a39f7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "4e11880c-bed0-430c-b23f-fa4f1a9a39f7",
  "debitor" : {
    "uuid" : "ecc5c988-34fb-48ad-a5d6-6d0793a052aa", // Debitor of D-9000000-aktuell
    "debitorRel" : {
      "uuid" : "866a888e-4008-4992-af28-76063ea1c57b",
      "anchor" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "f14d56ab-f975-4256-8881-e14543323c69", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
        "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000000",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13",
      "partnerNumber" : "P-90000",
      "partnerRel" : {
        "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
        "anchor" : {
          "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Tannenhof Bürotechnik eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
          "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
          "postalAddress" : {
            "zipcode" : "86150",
            "country" : "Germany",
            "city" : "Augsburg",
            "street" : "Am Anger 167"
          },
          "emailAddresses" : {
            "main" : "info@tannenhof-buerotechnik-eg.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920080"
          }
        }
      },
      "details" : {
        "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
        "registrationOffice" : "Registergericht Augsburg",
        "registrationNumber" : "555465",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "74a70903-dda0-4ff5-87cd-594134baa51e", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
      "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
      "iban" : "DE15990200000838881174",
      "bic" : "DEMVDEH0"
    },
    "defaultPrefix" : "aaa"
  },
  "bankAccount" : {
    "uuid" : "146a976d-aa6d-42ea-ad3b-aa1babdf8037", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0/aktuell)",
    "iban" : "DE86990200000766401011",
    "bic" : "DEMVDEH0"
  },
  "reference" : "D-9000000-aktuell",
  "agreement" : "2023-03-05",
  "validFrom" : "2023-03-08",
  "validTo" : null
}

UseCase Create Membership => Membership: Tannenhof Bürotechnik eG

Properties

Given

name	value
partnerNumber	P-90000
validFrom	2011-05-13
membershipFeeBillable	true

Partner: P-90000

HTTP GET "/api/hs/office/partners/P-90000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13",
  "partnerNumber" : "P-90000",
  "partnerRel" : {
    "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
    "anchor" : {
      "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
      "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
      "postalAddress" : {
        "zipcode" : "86150",
        "country" : "Germany",
        "city" : "Augsburg",
        "street" : "Am Anger 167"
      },
      "emailAddresses" : {
        "main" : "info@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 171 3920080"
      }
    }
  },
  "details" : {
    "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
    "registrationOffice" : "Registergericht Augsburg",
    "registrationNumber" : "555465",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13", // Partner: P-90000
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2011-05-13",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 9cd29d80-7c77-4fb3-9772-03a0fbc69ba8

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/9cd29d80-7c77-4fb3-9772-03a0fbc69ba8" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8",
  "partner" : {
    "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000000
reference	sign 2011-05-13
shareCount	37
comment	initial shares on joining
transactionDate	2011-05-13

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8",
  "partner" : {
    "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2011-05-13",
  "shareCount" : 37,
  "comment" : "initial shares on joining",
  "valueDate" : "2011-05-13"
}
EOF
=> status: 201 CREATED 4719213b-1296-48ad-b328-4dd66bde453e

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/4719213b-1296-48ad-b328-4dd66bde453e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "4719213b-1296-48ad-b328-4dd66bde453e",
  "membership.uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 37,
  "valueDate" : "2011-05-13",
  "reference" : "sign 2011-05-13",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000000
reference	sign 2011-05-13
assetValue	2368
comment	deposit for initial shares
transactionDate	2011-06-01

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8", // membershipUuid
  "partner" : {
    "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2011-05-13",
  "assetValue" : 2368,
  "comment" : "deposit for initial shares",
  "valueDate" : "2011-06-01"
}
EOF
=> status: 201 CREATED 87682593-ca13-4615-8822-8d6457c940be

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/87682593-ca13-4615-8822-8d6457c940be" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "87682593-ca13-4615-8822-8d6457c940be",
  "membership.uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8", // membershipUuid
  "membership.memberNumber" : "M-9000000",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2368,
  "valueDate" : "2011-06-01",
  "reference" : "sign 2011-05-13",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Susanne Weber (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	generalversammlung
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - Vertretung (P-90000)

Create SUBSCRIBER generalversammlung: Susanne Weber (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "8c9dc579-5897-46ad-b034-55e9fbb48d29", // Person: Susanne Weber
  "contact.uuid" : "b689044a-5929-4868-86f0-e5fbe944521d" // Contact: Susanne Weber - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED c872ad49-f496-4486-b34d-9239e3909efd

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/c872ad49-f496-4486-b34d-9239e3909efd" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "c872ad49-f496-4486-b34d-9239e3909efd",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "8c9dc579-5897-46ad-b034-55e9fbb48d29", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "b689044a-5929-4868-86f0-e5fbe944521d", // Contact: Susanne Weber - Vertretung (P-90000)
    "caption" : "Susanne Weber - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Ulmenstraße 729"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920066"
    }
  }
}

Contact: Torsten Schneider - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Birkenallee 253",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 89 99998954"
  },
  "emailAddresses" : {
    "main" : "torsten-schneider@example.net"
  }
}
EOF
=> status: 201 CREATED 7d492d21-7561-477b-816b-79ad537f285a

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	members-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
  "contact.uuid" : "7d492d21-7561-477b-816b-79ad537f285a" // Contact: Torsten Schneider - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED bbaf72fd-5127-4651-b000-ac2ddd4b7f92

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/bbaf72fd-5127-4651-b000-ac2ddd4b7f92" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "bbaf72fd-5127-4651-b000-ac2ddd4b7f92",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "7d492d21-7561-477b-816b-79ad537f285a", // Contact: Torsten Schneider - private Mailinglisten-Adresse
    "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Birkenallee 253"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998954"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	customers-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
  "contact.uuid" : "7d492d21-7561-477b-816b-79ad537f285a" // Contact: Torsten Schneider - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 69bf82e0-b750-41bc-907f-eafa6e16e31d

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/69bf82e0-b750-41bc-907f-eafa6e16e31d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "69bf82e0-b750-41bc-907f-eafa6e16e31d",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "7d492d21-7561-477b-816b-79ad537f285a", // Contact: Torsten Schneider - private Mailinglisten-Adresse
    "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Birkenallee 253"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998954"
    }
  }
}

Contact: Susanne Weber - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Susanne Weber - private Mailinglisten-Adresse",
  "postalAddress" : {
    "name" : "Geschäftsführung",
    "street" : "Schlehenweg 260",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 89 99998045"
  },
  "emailAddresses" : {
    "main" : "susanne-weber@example.net"
  }
}
EOF
=> status: 201 CREATED fde85137-447c-473e-b1f5-840c7f1d3a1f

UseCase Add Demo Subscription => SUBSCRIBER customers-discuss: Susanne Weber (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	customers-discuss
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - private Mailinglisten-Adresse

Create SUBSCRIBER customers-discuss: Susanne Weber (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-discuss",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "8c9dc579-5897-46ad-b034-55e9fbb48d29", // Person: Susanne Weber
  "contact.uuid" : "fde85137-447c-473e-b1f5-840c7f1d3a1f" // Contact: Susanne Weber - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED bfc4a8b1-7b9d-4216-ba76-bd580bbb57d4

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/bfc4a8b1-7b9d-4216-ba76-bd580bbb57d4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "bfc4a8b1-7b9d-4216-ba76-bd580bbb57d4",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "8c9dc579-5897-46ad-b034-55e9fbb48d29", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-discuss",
  "contact" : {
    "uuid" : "fde85137-447c-473e-b1f5-840c7f1d3a1f", // Contact: Susanne Weber - private Mailinglisten-Adresse
    "caption" : "Susanne Weber - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Schlehenweg 260",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	operations-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - Vertretung (P-90000)

Create SUBSCRIBER operations-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
  "contact.uuid" : "872a30c2-49c8-45e8-acd3-31db37a1571d" // Contact: Torsten Schneider - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED b5370040-7923-4d63-b0f2-428f4ac391b0

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/b5370040-7923-4d63-b0f2-428f4ac391b0" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b5370040-7923-4d63-b0f2-428f4ac391b0",
  "anchor" : {
    "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "49a3077b-c664-4d90-9c90-12e6e6055eeb", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "872a30c2-49c8-45e8-acd3-31db37a1571d", // Contact: Torsten Schneider - Vertretung (P-90000)
    "caption" : "Torsten Schneider - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Wiesengrund 246",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710870"
    }
  }
}

UseCase Create Partner => Partner: P-90001 - Christian Krause

Properties

Given

name	value
partnerNumber	P-90001
personType	NATURAL_PERSON
contactCaption	Christian Krause - Hauptkontakt (P-90001)
postalAddress	“name”: “Buchhaltung”, “street”: “Kirschblütenweg 603”, “zipcode”: “90402”, “city”: “Nürnberg”, “country”: “Germany”
officePhoneNumber	+49 176 04069019
emailAddress	post@christian-krause.example.org
givenName	Christian
familyName	Krause
birthday	1954-05-11

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Christian Krause

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "givenName" : "Christian",
  "familyName" : "Krause"
}
EOF
=> status: 201 CREATED 40942db7-d99e-4b51-9f0c-85fd04ab82f5

Contact: Christian Krause - Hauptkontakt (P-90001)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Krause - Hauptkontakt (P-90001)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Kirschblütenweg 603",
    "zipcode" : "90402",
    "city" : "Nürnberg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069019"
  },
  "emailAddresses" : {
    "main" : "post@christian-krause.example.org"
  }
}
EOF
=> status: 201 CREATED 40010f8b-15aa-44fe-87ab-fbb5ff047c6f

Create Partner: P-90001 - Christian Krause

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90001",
  "partnerRel" : {
    "anchor.uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "holder.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "contact.uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f" // Contact: Christian Krause - Hauptkontakt (P-90001)
  },
  "details" : {
    "birthday" : "1954-05-11"
  }
}
EOF
=> status: 201 CREATED 41217540-f947-4051-9c00-1d6b49ed2071

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Christian+Krause+-+Hauptkontakt+%28P-90001%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
  "anchor" : {
    "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
} ]

UseCase Create Demo Debitor => Debitor: Christian Krause - Rechnungsstelle (D-9000100)

Properties

Given

name	value
partnerPersonName	Christian Krause
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aab
bankAccountHolder	Christian Krause (P-90001/0)
iban	DE69990100000452472122
bic	DEMSDEH0
billingContactCaption	Christian Krause - Rechnungsstelle (D-9000100)
billingContactEmailAddress	rechnung0@christian-krause.example.org

BankAccount: Christian Krause (P-90001/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Christian Krause (P-90001/0)",
  "iban" : "DE69990100000452472122",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED f19ed597-c088-4e4f-ab44-cc6d0d0df76a

Contact: Christian Krause - Rechnungsstelle (D-9000100)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
  "emailAddresses" : {
    "main" : "rechnung0@christian-krause.example.org"
  }
}
EOF
=> status: 201 CREATED 90c4c4ab-897a-4ab0-b7af-706ae49d30f8

Create Debitor: Christian Krause - Rechnungsstelle (D-9000100)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "holder.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "contact.uuid" : "90c4c4ab-897a-4ab0-b7af-706ae49d30f8" // Contact: Christian Krause - Rechnungsstelle (D-9000100)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "f19ed597-c088-4e4f-ab44-cc6d0d0df76a", // BankAccount: Christian Krause (P-90001/0)
  "defaultPrefix" : "aab"
}
EOF
=> status: 201 CREATED 623e2069-fd5f-4baa-adb5-0b4887905c02

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/623e2069-fd5f-4baa-adb5-0b4887905c02" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "623e2069-fd5f-4baa-adb5-0b4887905c02",
  "debitorRel" : {
    "uuid" : "865280ff-8287-499a-93f6-34e2abcce162",
    "anchor" : {
      "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "holder" : {
      "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "90c4c4ab-897a-4ab0-b7af-706ae49d30f8", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
      "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@christian-krause.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000100",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071",
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "f19ed597-c088-4e4f-ab44-cc6d0d0df76a", // BankAccount: Christian Krause (P-90001/0)
    "holder" : "Christian Krause (P-90001/0)",
    "iban" : "DE69990100000452472122",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aab"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000100-aktuell

Properties

Given

name	value
debitorNumber	D-9000100
mandateReference	D-9000100-aktuell
bankAccountHolder	Christian Krause (P-90001/0/aktuell)
iban	DE34990400000981678500
bic	DEMDDEB0
agreement	2023-07-17
validFrom	2023-07-21

Debitor of D-9000100-aktuell

HTTP GET "/api/hs/office/debitors/D-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "623e2069-fd5f-4baa-adb5-0b4887905c02",
  "debitorRel" : {
    "uuid" : "865280ff-8287-499a-93f6-34e2abcce162",
    "anchor" : {
      "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "holder" : {
      "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "90c4c4ab-897a-4ab0-b7af-706ae49d30f8", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
      "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@christian-krause.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000100",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071",
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "f19ed597-c088-4e4f-ab44-cc6d0d0df76a", // BankAccount: Christian Krause (P-90001/0)
    "holder" : "Christian Krause (P-90001/0)",
    "iban" : "DE69990100000452472122",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aab"
}

BankAccount: Christian Krause (P-90001/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Christian Krause (P-90001/0/aktuell)",
  "iban" : "DE34990400000981678500",
  "bic" : "DEMDDEB0"
}
EOF
=> status: 201 CREATED ca76ac5e-6c5b-4d96-8a7a-e4ba1727adb9

Create SEPA-Mandat: D-9000100-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "623e2069-fd5f-4baa-adb5-0b4887905c02", // Debitor of D-9000100-aktuell
  "bankAccount.uuid" : "ca76ac5e-6c5b-4d96-8a7a-e4ba1727adb9", // BankAccount: Christian Krause (P-90001/0/aktuell)
  "reference" : "D-9000100-aktuell",
  "agreement" : "2023-07-17",
  "validFrom" : "2023-07-21"
}
EOF
=> status: 201 CREATED cd014887-1ee1-4ef4-bbe4-55ca0696e22a

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/cd014887-1ee1-4ef4-bbe4-55ca0696e22a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "cd014887-1ee1-4ef4-bbe4-55ca0696e22a",
  "debitor" : {
    "uuid" : "623e2069-fd5f-4baa-adb5-0b4887905c02", // Debitor of D-9000100-aktuell
    "debitorRel" : {
      "uuid" : "865280ff-8287-499a-93f6-34e2abcce162",
      "anchor" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "holder" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "90c4c4ab-897a-4ab0-b7af-706ae49d30f8", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
        "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@christian-krause.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000100",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071",
      "partnerNumber" : "P-90001",
      "partnerRel" : {
        "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
        "anchor" : {
          "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
          "personType" : "NATURAL_PERSON",
          "tradeName" : null,
          "salutation" : null,
          "title" : null,
          "givenName" : "Christian",
          "familyName" : "Krause"
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
          "caption" : "Christian Krause - Hauptkontakt (P-90001)",
          "postalAddress" : {
            "zipcode" : "90402",
            "country" : "Germany",
            "city" : "Nürnberg",
            "street" : "Kirschblütenweg 603",
            "name" : "Buchhaltung"
          },
          "emailAddresses" : {
            "main" : "post@christian-krause.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 176 04069019"
          }
        }
      },
      "details" : {
        "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
        "registrationOffice" : null,
        "registrationNumber" : null,
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : "1954-05-11",
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "f19ed597-c088-4e4f-ab44-cc6d0d0df76a", // BankAccount: Christian Krause (P-90001/0)
      "holder" : "Christian Krause (P-90001/0)",
      "iban" : "DE69990100000452472122",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aab"
  },
  "bankAccount" : {
    "uuid" : "ca76ac5e-6c5b-4d96-8a7a-e4ba1727adb9", // BankAccount: Christian Krause (P-90001/0/aktuell)
    "holder" : "Christian Krause (P-90001/0/aktuell)",
    "iban" : "DE34990400000981678500",
    "bic" : "DEMDDEB0"
  },
  "reference" : "D-9000100-aktuell",
  "agreement" : "2023-07-17",
  "validFrom" : "2023-07-21",
  "validTo" : null
}

UseCase Create Membership => Membership: Christian Krause

Properties

Given

name	value
partnerNumber	P-90001
validFrom	2008-01-10
membershipFeeBillable	true

Partner: P-90001

HTTP GET "/api/hs/office/partners/P-90001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071",
  "partnerNumber" : "P-90001",
  "partnerRel" : {
    "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
    "anchor" : {
      "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
      "caption" : "Christian Krause - Hauptkontakt (P-90001)",
      "postalAddress" : {
        "zipcode" : "90402",
        "country" : "Germany",
        "city" : "Nürnberg",
        "street" : "Kirschblütenweg 603",
        "name" : "Buchhaltung"
      },
      "emailAddresses" : {
        "main" : "post@christian-krause.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 176 04069019"
      }
    }
  },
  "details" : {
    "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
    "registrationOffice" : null,
    "registrationNumber" : null,
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : "1954-05-11",
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Christian Krause

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "41217540-f947-4051-9c00-1d6b49ed2071", // Partner: P-90001
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2008-01-10",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED a5467d27-6970-459e-b508-b6797da2abaa

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/a5467d27-6970-459e-b508-b6797da2abaa" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a5467d27-6970-459e-b508-b6797da2abaa",
  "partner" : {
    "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000100
reference	sign 2008-01-10
shareCount	32
comment	initial shares on joining
transactionDate	2008-01-10

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a5467d27-6970-459e-b508-b6797da2abaa",
  "partner" : {
    "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "a5467d27-6970-459e-b508-b6797da2abaa", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2008-01-10",
  "shareCount" : 32,
  "comment" : "initial shares on joining",
  "valueDate" : "2008-01-10"
}
EOF
=> status: 201 CREATED f14409ce-07f2-4ef4-b2cb-750f71d496c0

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/f14409ce-07f2-4ef4-b2cb-750f71d496c0" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f14409ce-07f2-4ef4-b2cb-750f71d496c0",
  "membership.uuid" : "a5467d27-6970-459e-b508-b6797da2abaa", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 32,
  "valueDate" : "2008-01-10",
  "reference" : "sign 2008-01-10",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000100
reference	sign 2008-01-10
assetValue	2048
comment	deposit for initial shares
transactionDate	2008-01-15

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a5467d27-6970-459e-b508-b6797da2abaa", // membershipUuid
  "partner" : {
    "uuid" : "41217540-f947-4051-9c00-1d6b49ed2071", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "a355e882-24ae-47c7-a8f4-44ab2ed190ab",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "d204c742-9ba0-45de-8628-33ea132bb462",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "a5467d27-6970-459e-b508-b6797da2abaa", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2008-01-10",
  "assetValue" : 2048,
  "comment" : "deposit for initial shares",
  "valueDate" : "2008-01-15"
}
EOF
=> status: 201 CREATED 9c85d888-2c70-42f4-8216-f47644a2511b

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/9c85d888-2c70-42f4-8216-f47644a2511b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "9c85d888-2c70-42f4-8216-f47644a2511b",
  "membership.uuid" : "a5467d27-6970-459e-b508-b6797da2abaa", // membershipUuid
  "membership.memberNumber" : "M-9000100",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2048,
  "valueDate" : "2008-01-15",
  "reference" : "sign 2008-01-10",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	generalversammlung
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER generalversammlung: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
  "holder.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
  "contact.uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 48f199ec-c025-4ea7-9026-b9ed134fde3b

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/48f199ec-c025-4ea7-9026-b9ed134fde3b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "48f199ec-c025-4ea7-9026-b9ed134fde3b",
  "anchor" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	customers-announce
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER customers-announce: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
  "holder.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
  "contact.uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 77436198-8b1a-4d7f-9df5-04dbb665820b

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/77436198-8b1a-4d7f-9df5-04dbb665820b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "77436198-8b1a-4d7f-9df5-04dbb665820b",
  "anchor" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	operations-announce
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER operations-announce: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
  "holder.uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
  "contact.uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 8a2bfbf0-dfec-4bd8-8c65-3ccc656132c4

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/8a2bfbf0-dfec-4bd8-8c65-3ccc656132c4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "8a2bfbf0-dfec-4bd8-8c65-3ccc656132c4",
  "anchor" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "40942db7-d99e-4b51-9f0c-85fd04ab82f5", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "40010f8b-15aa-44fe-87ab-fbb5ff047c6f", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Create Partner => Partner: P-90002 - Fischer Pflege GmbH

Properties

Given

name	value
partnerNumber	P-90002
personType	LEGAL_PERSON
contactCaption	Fischer Pflege GmbH - Hauptkontakt (P-90002)
postalAddress	“street”: “Bachstraße 553”, “zipcode”: “28195”, “city”: “Bremen”, “country”: “Germany”
officePhoneNumber	+49 171 3920003
emailAddress	info@fischer-pflege-gmbh.example.org
tradeName	Fischer Pflege GmbH
registrationOffice	Registergericht Bremen
registrationNumber	310659

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Fischer Pflege GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Fischer Pflege GmbH"
}
EOF
=> status: 201 CREATED 7e8bd19c-92e2-43cb-b92c-5d860c911696

Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
  "postalAddress" : {
    "street" : "Bachstraße 553",
    "zipcode" : "28195",
    "city" : "Bremen",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920003"
  },
  "emailAddresses" : {
    "main" : "info@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 13675ade-7b1f-4e46-8ed2-6bd2927e790f

Create Partner: P-90002 - Fischer Pflege GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90002",
  "partnerRel" : {
    "anchor.uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "holder.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "contact.uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f" // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
  },
  "details" : {
    "registrationOffice" : "Registergericht Bremen",
    "registrationNumber" : "310659"
  }
}
EOF
=> status: 201 CREATED 832befc4-6419-4b35-8c4d-ef9d6825c24d

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Fischer+Pflege+GmbH+-+Hauptkontakt+%28P-90002%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
  "anchor" : {
    "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
    "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
    "postalAddress" : {
      "zipcode" : "28195",
      "country" : "Germany",
      "city" : "Bremen",
      "street" : "Bachstraße 553"
    },
    "emailAddresses" : {
      "main" : "info@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920003"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Daniel Fischer - Vertretung (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	REPRESENTATIVE
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - Vertretung (P-90002)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Dorfstraße 882”, “zipcode”: “50667”, “city”: “Köln”, “country”: “Germany”
phoneNumber	+49 221 4710601
emailAddress	daniel-fischer@fischer-pflege-gmbh.example.org

Person: Daniel Fischer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fischer",
  "givenName" : "Daniel"
}
EOF
=> status: 201 CREATED b80c5196-2574-4c4a-b2ca-1049de352a65

Contact: Daniel Fischer - Vertretung (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Daniel Fischer - Vertretung (P-90002)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Dorfstraße 882",
    "zipcode" : "50667",
    "city" : "Köln",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 221 4710601"
  },
  "emailAddresses" : {
    "main" : "daniel-fischer@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED a1ab61e5-ef81-4d2a-852b-3833a1f14721

Create REPRESENTATIVE: Daniel Fischer - Vertretung (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
  "holder.uuid" : "b80c5196-2574-4c4a-b2ca-1049de352a65", // Person: Daniel Fischer
  "contact.uuid" : "a1ab61e5-ef81-4d2a-852b-3833a1f14721" // Contact: Daniel Fischer - Vertretung (P-90002)
}
EOF
=> status: 201 CREATED a73797dc-b269-424a-a1ad-9f896efcb6b1

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/a73797dc-b269-424a-a1ad-9f896efcb6b1" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a73797dc-b269-424a-a1ad-9f896efcb6b1",
  "anchor" : {
    "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "b80c5196-2574-4c4a-b2ca-1049de352a65", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "a1ab61e5-ef81-4d2a-852b-3833a1f14721", // Contact: Daniel Fischer - Vertretung (P-90002)
    "caption" : "Daniel Fischer - Vertretung (P-90002)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Dorfstraße 882",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710601"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Detlef Keller - Technik (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	OPERATIONS
holderGivenName	Detlef
holderFamilyName	Keller
contactCaption	Detlef Keller - Technik (P-90002)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Goethestraße 288”, “zipcode”: “53111”, “city”: “Bonn”, “country”: “Germany”
phoneNumber	+49 171 3920098
emailAddress	detlef-keller@fischer-pflege-gmbh.example.org

Person: Detlef Keller

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Keller",
  "givenName" : "Detlef"
}
EOF
=> status: 201 CREATED 0d41fc5e-ba10-4a59-a6e2-2f6e67502b96

Contact: Detlef Keller - Technik (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Detlef Keller - Technik (P-90002)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Goethestraße 288",
    "zipcode" : "53111",
    "city" : "Bonn",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920098"
  },
  "emailAddresses" : {
    "main" : "detlef-keller@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 88edd667-2b10-4181-98ee-c827476af9b2

Create OPERATIONS: Detlef Keller - Technik (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
  "holder.uuid" : "0d41fc5e-ba10-4a59-a6e2-2f6e67502b96", // Person: Detlef Keller
  "contact.uuid" : "88edd667-2b10-4181-98ee-c827476af9b2" // Contact: Detlef Keller - Technik (P-90002)
}
EOF
=> status: 201 CREATED 5efa947f-24f9-41f4-b60d-10afd9de2cb5

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/5efa947f-24f9-41f4-b60d-10afd9de2cb5" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "5efa947f-24f9-41f4-b60d-10afd9de2cb5",
  "anchor" : {
    "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "0d41fc5e-ba10-4a59-a6e2-2f6e67502b96", // Person: Detlef Keller
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Detlef",
    "familyName" : "Keller"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "88edd667-2b10-4181-98ee-c827476af9b2", // Contact: Detlef Keller - Technik (P-90002)
    "caption" : "Detlef Keller - Technik (P-90002)",
    "postalAddress" : {
      "zipcode" : "53111",
      "country" : "Germany",
      "city" : "Bonn",
      "street" : "Goethestraße 288",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "detlef-keller@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920098"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Doris Schneider - Technik (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	OPERATIONS
holderGivenName	Doris
holderFamilyName	Schneider
contactCaption	Doris Schneider - Technik (P-90002)
postalAddress	“street”: “Nelkenweg 142”, “zipcode”: “80331”, “city”: “München”, “country”: “Germany”
phoneNumber	+49 89 99998458
emailAddress	doris-schneider@fischer-pflege-gmbh.example.org

Person: Doris Schneider

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schneider",
  "givenName" : "Doris"
}
EOF
=> status: 201 CREATED 656096fc-ca03-453d-bf4e-de5694558039

Contact: Doris Schneider - Technik (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Doris Schneider - Technik (P-90002)",
  "postalAddress" : {
    "street" : "Nelkenweg 142",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 89 99998458"
  },
  "emailAddresses" : {
    "main" : "doris-schneider@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED b8478ee7-14bb-46dd-8847-9e65e5216554

Create OPERATIONS: Doris Schneider - Technik (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
  "holder.uuid" : "656096fc-ca03-453d-bf4e-de5694558039", // Person: Doris Schneider
  "contact.uuid" : "b8478ee7-14bb-46dd-8847-9e65e5216554" // Contact: Doris Schneider - Technik (P-90002)
}
EOF
=> status: 201 CREATED c58269bc-3f9b-408b-9d15-d65c5d88cc60

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/c58269bc-3f9b-408b-9d15-d65c5d88cc60" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "c58269bc-3f9b-408b-9d15-d65c5d88cc60",
  "anchor" : {
    "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "656096fc-ca03-453d-bf4e-de5694558039", // Person: Doris Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Doris",
    "familyName" : "Schneider"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "b8478ee7-14bb-46dd-8847-9e65e5216554", // Contact: Doris Schneider - Technik (P-90002)
    "caption" : "Doris Schneider - Technik (P-90002)",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Nelkenweg 142"
    },
    "emailAddresses" : {
      "main" : "doris-schneider@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 89 99998458"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	false
defaultPrefix	aac
bankAccountHolder	Fischer Pflege GmbH (P-90002/0)
iban	DE35990100000247429672
bic	DEMSDEH0
billingContactCaption	Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
billingContactEmailAddress	rechnung0@fischer-pflege-gmbh.example.org

BankAccount: Fischer Pflege GmbH (P-90002/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/0)",
  "iban" : "DE35990100000247429672",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED b113f06c-f953-4dc9-9034-f3ef0d2ed994

Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
  "emailAddresses" : {
    "main" : "rechnung0@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 308232eb-a709-4113-adea-ff4e5973923a

Create Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "holder.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "contact.uuid" : "308232eb-a709-4113-adea-ff4e5973923a" // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "b113f06c-f953-4dc9-9034-f3ef0d2ed994", // BankAccount: Fischer Pflege GmbH (P-90002/0)
  "defaultPrefix" : "aac"
}
EOF
=> status: 201 CREATED 2cb5d22d-d651-47c8-836e-6421eff9ae4a

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/2cb5d22d-d651-47c8-836e-6421eff9ae4a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2cb5d22d-d651-47c8-836e-6421eff9ae4a",
  "debitorRel" : {
    "uuid" : "1dfb5afa-5aa2-4d2a-87d3-2e947ca7b57e",
    "anchor" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "308232eb-a709-4113-adea-ff4e5973923a", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000200",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "b113f06c-f953-4dc9-9034-f3ef0d2ed994", // BankAccount: Fischer Pflege GmbH (P-90002/0)
    "holder" : "Fischer Pflege GmbH (P-90002/0)",
    "iban" : "DE35990100000247429672",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aac"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000200-aktuell

Properties

Given

name	value
debitorNumber	D-9000200
mandateReference	D-9000200-aktuell
bankAccountHolder	Fischer Pflege GmbH (P-90002/0/aktuell)
iban	DE76990100000045503743
bic	DEMSDEH0
agreement	2013-05-03
validFrom	2013-05-17

Debitor of D-9000200-aktuell

HTTP GET "/api/hs/office/debitors/D-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2cb5d22d-d651-47c8-836e-6421eff9ae4a",
  "debitorRel" : {
    "uuid" : "1dfb5afa-5aa2-4d2a-87d3-2e947ca7b57e",
    "anchor" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "308232eb-a709-4113-adea-ff4e5973923a", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000200",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "b113f06c-f953-4dc9-9034-f3ef0d2ed994", // BankAccount: Fischer Pflege GmbH (P-90002/0)
    "holder" : "Fischer Pflege GmbH (P-90002/0)",
    "iban" : "DE35990100000247429672",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aac"
}

BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/0/aktuell)",
  "iban" : "DE76990100000045503743",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED b18b3e87-970a-415e-80e7-aadd3eefea40

Create SEPA-Mandat: D-9000200-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "2cb5d22d-d651-47c8-836e-6421eff9ae4a", // Debitor of D-9000200-aktuell
  "bankAccount.uuid" : "b18b3e87-970a-415e-80e7-aadd3eefea40", // BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)
  "reference" : "D-9000200-aktuell",
  "agreement" : "2013-05-03",
  "validFrom" : "2013-05-17"
}
EOF
=> status: 201 CREATED 6e171b6e-e090-4784-b83d-5375b6602531

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/6e171b6e-e090-4784-b83d-5375b6602531" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "6e171b6e-e090-4784-b83d-5375b6602531",
  "debitor" : {
    "uuid" : "2cb5d22d-d651-47c8-836e-6421eff9ae4a", // Debitor of D-9000200-aktuell
    "debitorRel" : {
      "uuid" : "1dfb5afa-5aa2-4d2a-87d3-2e947ca7b57e",
      "anchor" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "308232eb-a709-4113-adea-ff4e5973923a", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
        "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000200",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
      "partnerNumber" : "P-90002",
      "partnerRel" : {
        "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
        "anchor" : {
          "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Fischer Pflege GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
          "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
          "postalAddress" : {
            "zipcode" : "28195",
            "country" : "Germany",
            "city" : "Bremen",
            "street" : "Bachstraße 553"
          },
          "emailAddresses" : {
            "main" : "info@fischer-pflege-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920003"
          }
        }
      },
      "details" : {
        "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
        "registrationOffice" : "Registergericht Bremen",
        "registrationNumber" : "310659",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : false,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "b113f06c-f953-4dc9-9034-f3ef0d2ed994", // BankAccount: Fischer Pflege GmbH (P-90002/0)
      "holder" : "Fischer Pflege GmbH (P-90002/0)",
      "iban" : "DE35990100000247429672",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aac"
  },
  "bankAccount" : {
    "uuid" : "b18b3e87-970a-415e-80e7-aadd3eefea40", // BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)
    "holder" : "Fischer Pflege GmbH (P-90002/0/aktuell)",
    "iban" : "DE76990100000045503743",
    "bic" : "DEMSDEH0"
  },
  "reference" : "D-9000200-aktuell",
  "agreement" : "2013-05-03",
  "validFrom" : "2013-05-17",
  "validTo" : null
}

UseCase Create Demo Debitor => Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
debitorNumberSuffix	01
billable	true
vatBusiness	true
defaultPrefix	aad
bankAccountHolder	Fischer Pflege GmbH (P-90002/1)
iban	DE44990100000597317337
bic	DEMSDEH0
billingContactCaption	Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
billingContactEmailAddress	rechnung1@fischer-pflege-gmbh.example.org

BankAccount: Fischer Pflege GmbH (P-90002/1)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/1)",
  "iban" : "DE44990100000597317337",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 2f62e909-b276-4d89-a5bf-6fd7d3b8b79c

Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
  "emailAddresses" : {
    "main" : "rechnung1@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED dfd7988d-166e-4c1b-83f7-c96f023a839e

Create Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "holder.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "contact.uuid" : "dfd7988d-166e-4c1b-83f7-c96f023a839e" // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
  },
  "debitorNumberSuffix" : "01",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "2f62e909-b276-4d89-a5bf-6fd7d3b8b79c", // BankAccount: Fischer Pflege GmbH (P-90002/1)
  "defaultPrefix" : "aad"
}
EOF
=> status: 201 CREATED 7f19eb42-012c-46dd-a721-9f2919b50446

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/7f19eb42-012c-46dd-a721-9f2919b50446" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7f19eb42-012c-46dd-a721-9f2919b50446",
  "debitorRel" : {
    "uuid" : "29ff4c7f-7f96-4f59-b423-e0414e8ae6ee",
    "anchor" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "dfd7988d-166e-4c1b-83f7-c96f023a839e", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung1@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000201",
  "debitorNumberSuffix" : "01",
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "2f62e909-b276-4d89-a5bf-6fd7d3b8b79c", // BankAccount: Fischer Pflege GmbH (P-90002/1)
    "holder" : "Fischer Pflege GmbH (P-90002/1)",
    "iban" : "DE44990100000597317337",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aad"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000201-aktuell

Properties

Given

name	value
debitorNumber	D-9000201
mandateReference	D-9000201-aktuell
bankAccountHolder	Fischer Pflege GmbH (P-90002/1/aktuell)
iban	DE41990100000935066832
bic	DEMSDEH0
agreement	2020-07-10
validFrom	2020-07-14

Debitor of D-9000201-aktuell

HTTP GET "/api/hs/office/debitors/D-9000201" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7f19eb42-012c-46dd-a721-9f2919b50446",
  "debitorRel" : {
    "uuid" : "29ff4c7f-7f96-4f59-b423-e0414e8ae6ee",
    "anchor" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "dfd7988d-166e-4c1b-83f7-c96f023a839e", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung1@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000201",
  "debitorNumberSuffix" : "01",
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "2f62e909-b276-4d89-a5bf-6fd7d3b8b79c", // BankAccount: Fischer Pflege GmbH (P-90002/1)
    "holder" : "Fischer Pflege GmbH (P-90002/1)",
    "iban" : "DE44990100000597317337",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aad"
}

BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/1/aktuell)",
  "iban" : "DE41990100000935066832",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 0159b9f8-760f-49ae-a849-1bb438c8b01c

Create SEPA-Mandat: D-9000201-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "7f19eb42-012c-46dd-a721-9f2919b50446", // Debitor of D-9000201-aktuell
  "bankAccount.uuid" : "0159b9f8-760f-49ae-a849-1bb438c8b01c", // BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)
  "reference" : "D-9000201-aktuell",
  "agreement" : "2020-07-10",
  "validFrom" : "2020-07-14"
}
EOF
=> status: 201 CREATED e5823671-7937-421d-8749-a1e087e75296

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/e5823671-7937-421d-8749-a1e087e75296" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e5823671-7937-421d-8749-a1e087e75296",
  "debitor" : {
    "uuid" : "7f19eb42-012c-46dd-a721-9f2919b50446", // Debitor of D-9000201-aktuell
    "debitorRel" : {
      "uuid" : "29ff4c7f-7f96-4f59-b423-e0414e8ae6ee",
      "anchor" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "dfd7988d-166e-4c1b-83f7-c96f023a839e", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
        "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung1@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000201",
    "debitorNumberSuffix" : "01",
    "partner" : {
      "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
      "partnerNumber" : "P-90002",
      "partnerRel" : {
        "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
        "anchor" : {
          "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Fischer Pflege GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
          "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
          "postalAddress" : {
            "zipcode" : "28195",
            "country" : "Germany",
            "city" : "Bremen",
            "street" : "Bachstraße 553"
          },
          "emailAddresses" : {
            "main" : "info@fischer-pflege-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920003"
          }
        }
      },
      "details" : {
        "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
        "registrationOffice" : "Registergericht Bremen",
        "registrationNumber" : "310659",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "2f62e909-b276-4d89-a5bf-6fd7d3b8b79c", // BankAccount: Fischer Pflege GmbH (P-90002/1)
      "holder" : "Fischer Pflege GmbH (P-90002/1)",
      "iban" : "DE44990100000597317337",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aad"
  },
  "bankAccount" : {
    "uuid" : "0159b9f8-760f-49ae-a849-1bb438c8b01c", // BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)
    "holder" : "Fischer Pflege GmbH (P-90002/1/aktuell)",
    "iban" : "DE41990100000935066832",
    "bic" : "DEMSDEH0"
  },
  "reference" : "D-9000201-aktuell",
  "agreement" : "2020-07-10",
  "validFrom" : "2020-07-14",
  "validTo" : null
}

UseCase Create Membership => Membership: Fischer Pflege GmbH

Properties

Given

name	value
partnerNumber	P-90002
validFrom	2010-07-10
membershipFeeBillable	true

Partner: P-90002

HTTP GET "/api/hs/office/partners/P-90002" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d",
  "partnerNumber" : "P-90002",
  "partnerRel" : {
    "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
    "anchor" : {
      "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
      "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
      "postalAddress" : {
        "zipcode" : "28195",
        "country" : "Germany",
        "city" : "Bremen",
        "street" : "Bachstraße 553"
      },
      "emailAddresses" : {
        "main" : "info@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 171 3920003"
      }
    }
  },
  "details" : {
    "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
    "registrationOffice" : "Registergericht Bremen",
    "registrationNumber" : "310659",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Fischer Pflege GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d", // Partner: P-90002
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2010-07-10",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 201013d4-4258-4842-97e7-23af2917ee80

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/201013d4-4258-4842-97e7-23af2917ee80" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "201013d4-4258-4842-97e7-23af2917ee80",
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000200
reference	sign 2010-07-10
shareCount	35
comment	initial shares on joining
transactionDate	2010-07-10

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "201013d4-4258-4842-97e7-23af2917ee80",
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "201013d4-4258-4842-97e7-23af2917ee80", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2010-07-10",
  "shareCount" : 35,
  "comment" : "initial shares on joining",
  "valueDate" : "2010-07-10"
}
EOF
=> status: 201 CREATED 6eb9af70-7f1e-4ea7-af63-65e8b92f314e

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/6eb9af70-7f1e-4ea7-af63-65e8b92f314e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "6eb9af70-7f1e-4ea7-af63-65e8b92f314e",
  "membership.uuid" : "201013d4-4258-4842-97e7-23af2917ee80", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 35,
  "valueDate" : "2010-07-10",
  "reference" : "sign 2010-07-10",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000200
reference	sign 2010-07-10
assetValue	2240
comment	deposit for initial shares
transactionDate	2010-07-11

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "201013d4-4258-4842-97e7-23af2917ee80", // membershipUuid
  "partner" : {
    "uuid" : "832befc4-6419-4b35-8c4d-ef9d6825c24d", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "99662b1e-3350-40a1-945b-bae848090baf",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "13675ade-7b1f-4e46-8ed2-6bd2927e790f", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "6fd9d250-fe28-4ac7-8272-5bcb3fd8dd63",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "201013d4-4258-4842-97e7-23af2917ee80", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2010-07-10",
  "assetValue" : 2240,
  "comment" : "deposit for initial shares",
  "valueDate" : "2010-07-11"
}
EOF
=> status: 201 CREATED 21c2e824-f9ff-4164-b66b-87599d8b04c4

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/21c2e824-f9ff-4164-b66b-87599d8b04c4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "21c2e824-f9ff-4164-b66b-87599d8b04c4",
  "membership.uuid" : "201013d4-4258-4842-97e7-23af2917ee80", // membershipUuid
  "membership.memberNumber" : "M-9000200",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2.24E+3,
  "valueDate" : "2010-07-11",
  "reference" : "sign 2010-07-10",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

Contact: Daniel Fischer - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Erlenkamp 678",
    "zipcode" : "70173",
    "city" : "Stuttgart",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 176 04069030"
  },
  "emailAddresses" : {
    "main" : "daniel-fischer@example.net"
  }
}
EOF
=> status: 201 CREATED 544d08db-807c-456c-81e9-99d00c365940

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Daniel Fischer (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
mailingList	members-announce
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Daniel Fischer (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
  "holder.uuid" : "b80c5196-2574-4c4a-b2ca-1049de352a65", // Person: Daniel Fischer
  "contact.uuid" : "544d08db-807c-456c-81e9-99d00c365940" // Contact: Daniel Fischer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED dd79783c-3b59-40de-b443-06967f5d60e2

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/dd79783c-3b59-40de-b443-06967f5d60e2" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "dd79783c-3b59-40de-b443-06967f5d60e2",
  "anchor" : {
    "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "b80c5196-2574-4c4a-b2ca-1049de352a65", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "544d08db-807c-456c-81e9-99d00c365940", // Contact: Daniel Fischer - private Mailinglisten-Adresse
    "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "70173",
      "country" : "Germany",
      "city" : "Stuttgart",
      "street" : "Erlenkamp 678"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 176 04069030"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Daniel Fischer (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
mailingList	customers-announce
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Daniel Fischer (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
  "holder.uuid" : "b80c5196-2574-4c4a-b2ca-1049de352a65", // Person: Daniel Fischer
  "contact.uuid" : "544d08db-807c-456c-81e9-99d00c365940" // Contact: Daniel Fischer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 2db92de2-6bfb-445d-9c97-164ebc3deb35

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/2db92de2-6bfb-445d-9c97-164ebc3deb35" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2db92de2-6bfb-445d-9c97-164ebc3deb35",
  "anchor" : {
    "uuid" : "7e8bd19c-92e2-43cb-b92c-5d860c911696", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "b80c5196-2574-4c4a-b2ca-1049de352a65", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "544d08db-807c-456c-81e9-99d00c365940", // Contact: Daniel Fischer - private Mailinglisten-Adresse
    "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "70173",
      "country" : "Germany",
      "city" : "Stuttgart",
      "street" : "Erlenkamp 678"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 176 04069030"
    }
  }
}

UseCase Create Partner => Partner: P-90003 - Fuchs GmbH

Properties

Given

name	value
partnerNumber	P-90003
personType	LEGAL_PERSON
contactCaption	Fuchs GmbH - Hauptkontakt (P-90003)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Bachstraße 290”, “zipcode”: “80331”, “city”: “München”, “country”: “Germany”
officePhoneNumber	+49 89 99998009
emailAddress	info@fuchs-gmbh.example.org
tradeName	Fuchs GmbH
registrationOffice	Registergericht München
registrationNumber	322619

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Fuchs GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Fuchs GmbH"
}
EOF
=> status: 201 CREATED 38a84fde-b84d-417e-b06d-3d3801ff7515

Contact: Fuchs GmbH - Hauptkontakt (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Bachstraße 290",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 89 99998009"
  },
  "emailAddresses" : {
    "main" : "info@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 28eb5211-0433-401c-b9ad-84d59216e731

Create Partner: P-90003 - Fuchs GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90003",
  "partnerRel" : {
    "anchor.uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "holder.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "contact.uuid" : "28eb5211-0433-401c-b9ad-84d59216e731" // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
  },
  "details" : {
    "registrationOffice" : "Registergericht München",
    "registrationNumber" : "322619"
  }
}
EOF
=> status: 201 CREATED 21785428-801b-49a2-a47b-096228eb2dca

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Fuchs+GmbH+-+Hauptkontakt+%28P-90003%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "8a23eae6-9197-471c-95a5-5bf637af2edc",
  "anchor" : {
    "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "28eb5211-0433-401c-b9ad-84d59216e731", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
    "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Bachstraße 290",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "info@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 89 99998009"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Christian Fuchs - Vertretung (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
relationType	REPRESENTATIVE
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - Vertretung (P-90003)
postalAddress	“street”: “Heideweg 441”, “zipcode”: “10115”, “city”: “Berlin”, “country”: “Germany”
phoneNumber	+49 30 23125540
emailAddress	christian-fuchs@fuchs-gmbh.example.org

Person: Christian Fuchs

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fuchs",
  "givenName" : "Christian"
}
EOF
=> status: 201 CREATED 01954c48-1128-4af2-9789-2ce653b4063a

Contact: Christian Fuchs - Vertretung (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Fuchs - Vertretung (P-90003)",
  "postalAddress" : {
    "street" : "Heideweg 441",
    "zipcode" : "10115",
    "city" : "Berlin",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 30 23125540"
  },
  "emailAddresses" : {
    "main" : "christian-fuchs@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 4bc2f3ab-8f9d-4a9a-a27a-5a17658931a5

Create REPRESENTATIVE: Christian Fuchs - Vertretung (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
  "holder.uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
  "contact.uuid" : "4bc2f3ab-8f9d-4a9a-a27a-5a17658931a5" // Contact: Christian Fuchs - Vertretung (P-90003)
}
EOF
=> status: 201 CREATED 1e8c96e4-6805-4b7a-b4df-0b2987882cb0

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/1e8c96e4-6805-4b7a-b4df-0b2987882cb0" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "1e8c96e4-6805-4b7a-b4df-0b2987882cb0",
  "anchor" : {
    "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "4bc2f3ab-8f9d-4a9a-a27a-5a17658931a5", // Contact: Christian Fuchs - Vertretung (P-90003)
    "caption" : "Christian Fuchs - Vertretung (P-90003)",
    "postalAddress" : {
      "zipcode" : "10115",
      "country" : "Germany",
      "city" : "Berlin",
      "street" : "Heideweg 441"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 30 23125540"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Gabriele Meyer - Technik (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
relationType	OPERATIONS
holderGivenName	Gabriele
holderFamilyName	Meyer
contactCaption	Gabriele Meyer - Technik (P-90003)
postalAddress	“street”: “Wiesengrund 118”, “zipcode”: “28195”, “city”: “Bremen”, “country”: “Germany”
phoneNumber	+49 171 3920029
emailAddress	gabriele-meyer@fuchs-gmbh.example.org

Person: Gabriele Meyer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Meyer",
  "givenName" : "Gabriele"
}
EOF
=> status: 201 CREATED b5326873-263b-496a-b0cd-c224f5de0277

Contact: Gabriele Meyer - Technik (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Gabriele Meyer - Technik (P-90003)",
  "postalAddress" : {
    "street" : "Wiesengrund 118",
    "zipcode" : "28195",
    "city" : "Bremen",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920029"
  },
  "emailAddresses" : {
    "main" : "gabriele-meyer@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 2e1aa363-7695-4dae-bcde-6d0a36d01c43

Create OPERATIONS: Gabriele Meyer - Technik (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
  "holder.uuid" : "b5326873-263b-496a-b0cd-c224f5de0277", // Person: Gabriele Meyer
  "contact.uuid" : "2e1aa363-7695-4dae-bcde-6d0a36d01c43" // Contact: Gabriele Meyer - Technik (P-90003)
}
EOF
=> status: 201 CREATED b682d4e6-3d1f-4d93-91bf-494efb224d5e

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/b682d4e6-3d1f-4d93-91bf-494efb224d5e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b682d4e6-3d1f-4d93-91bf-494efb224d5e",
  "anchor" : {
    "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "b5326873-263b-496a-b0cd-c224f5de0277", // Person: Gabriele Meyer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Gabriele",
    "familyName" : "Meyer"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "2e1aa363-7695-4dae-bcde-6d0a36d01c43", // Contact: Gabriele Meyer - Technik (P-90003)
    "caption" : "Gabriele Meyer - Technik (P-90003)",
    "postalAddress" : {
      "zipcode" : "28195",
      "country" : "Germany",
      "city" : "Bremen",
      "street" : "Wiesengrund 118"
    },
    "emailAddresses" : {
      "main" : "gabriele-meyer@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920029"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Fuchs GmbH - Rechnungsstelle (D-9000300)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aae
bankAccountHolder	Fuchs GmbH (P-90003/0)
iban	DE44990300000591816846
bic	DEMRDEF0
billingContactCaption	Fuchs GmbH - Rechnungsstelle (D-9000300)
billingContactEmailAddress	rechnung0@fuchs-gmbh.example.org

BankAccount: Fuchs GmbH (P-90003/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fuchs GmbH (P-90003/0)",
  "iban" : "DE44990300000591816846",
  "bic" : "DEMRDEF0"
}
EOF
=> status: 201 CREATED 65ff3ec5-ef59-4654-b456-37f8a24eea77

Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fuchs GmbH - Rechnungsstelle (D-9000300)",
  "emailAddresses" : {
    "main" : "rechnung0@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 47b63579-fe0f-4ee8-bbe7-f6752a622401

Create Debitor: Fuchs GmbH - Rechnungsstelle (D-9000300)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "holder.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "contact.uuid" : "47b63579-fe0f-4ee8-bbe7-f6752a622401" // Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "65ff3ec5-ef59-4654-b456-37f8a24eea77", // BankAccount: Fuchs GmbH (P-90003/0)
  "defaultPrefix" : "aae"
}
EOF
=> status: 201 CREATED b27132d5-726c-431b-8889-6b285f5a8c1a

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/b27132d5-726c-431b-8889-6b285f5a8c1a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b27132d5-726c-431b-8889-6b285f5a8c1a",
  "debitorRel" : {
    "uuid" : "a7432197-48f8-432b-aaf6-206792bafc8d",
    "anchor" : {
      "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "47b63579-fe0f-4ee8-bbe7-f6752a622401", // Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)
      "caption" : "Fuchs GmbH - Rechnungsstelle (D-9000300)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fuchs-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000300",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "21785428-801b-49a2-a47b-096228eb2dca",
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "8a23eae6-9197-471c-95a5-5bf637af2edc",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "28eb5211-0433-401c-b9ad-84d59216e731", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "e7f1716e-c3d0-4276-8177-288bc047d143",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "65ff3ec5-ef59-4654-b456-37f8a24eea77", // BankAccount: Fuchs GmbH (P-90003/0)
    "holder" : "Fuchs GmbH (P-90003/0)",
    "iban" : "DE44990300000591816846",
    "bic" : "DEMRDEF0"
  },
  "defaultPrefix" : "aae"
}

UseCase Create Membership => Membership: Fuchs GmbH

Properties

Given

name	value
partnerNumber	P-90003
validFrom	2002-02-07
membershipFeeBillable	true

Partner: P-90003

HTTP GET "/api/hs/office/partners/P-90003" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "21785428-801b-49a2-a47b-096228eb2dca",
  "partnerNumber" : "P-90003",
  "partnerRel" : {
    "uuid" : "8a23eae6-9197-471c-95a5-5bf637af2edc",
    "anchor" : {
      "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "28eb5211-0433-401c-b9ad-84d59216e731", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
      "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
      "postalAddress" : {
        "zipcode" : "80331",
        "country" : "Germany",
        "city" : "München",
        "street" : "Bachstraße 290",
        "name" : "Rechnungsstelle"
      },
      "emailAddresses" : {
        "main" : "info@fuchs-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 89 99998009"
      }
    }
  },
  "details" : {
    "uuid" : "e7f1716e-c3d0-4276-8177-288bc047d143",
    "registrationOffice" : "Registergericht München",
    "registrationNumber" : "322619",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Fuchs GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "21785428-801b-49a2-a47b-096228eb2dca", // Partner: P-90003
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2002-02-07",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED ad873ef4-ad63-4824-927c-a4ff13d3b414

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/ad873ef4-ad63-4824-927c-a4ff13d3b414" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414",
  "partner" : {
    "uuid" : "21785428-801b-49a2-a47b-096228eb2dca", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "8a23eae6-9197-471c-95a5-5bf637af2edc",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "28eb5211-0433-401c-b9ad-84d59216e731", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "e7f1716e-c3d0-4276-8177-288bc047d143",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000300
reference	sign 2002-02-07
shareCount	38
comment	initial shares on joining
transactionDate	2002-02-07

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000300" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414",
  "partner" : {
    "uuid" : "21785428-801b-49a2-a47b-096228eb2dca", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "8a23eae6-9197-471c-95a5-5bf637af2edc",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "28eb5211-0433-401c-b9ad-84d59216e731", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "e7f1716e-c3d0-4276-8177-288bc047d143",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2002-02-07",
  "shareCount" : 38,
  "comment" : "initial shares on joining",
  "valueDate" : "2002-02-07"
}
EOF
=> status: 201 CREATED 22081545-3c43-477a-bbd7-325981494c8f

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/22081545-3c43-477a-bbd7-325981494c8f" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "22081545-3c43-477a-bbd7-325981494c8f",
  "membership.uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 38,
  "valueDate" : "2002-02-07",
  "reference" : "sign 2002-02-07",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000300
reference	sign 2002-02-07
assetValue	2432
comment	deposit for initial shares
transactionDate	2002-02-17

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000300" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414", // membershipUuid
  "partner" : {
    "uuid" : "21785428-801b-49a2-a47b-096228eb2dca", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "8a23eae6-9197-471c-95a5-5bf637af2edc",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "28eb5211-0433-401c-b9ad-84d59216e731", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "e7f1716e-c3d0-4276-8177-288bc047d143",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2002-02-07",
  "assetValue" : 2432,
  "comment" : "deposit for initial shares",
  "valueDate" : "2002-02-17"
}
EOF
=> status: 201 CREATED 0d457fbb-771c-4dd4-8680-7c60d166609c

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/0d457fbb-771c-4dd4-8680-7c60d166609c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "0d457fbb-771c-4dd4-8680-7c60d166609c",
  "membership.uuid" : "ad873ef4-ad63-4824-927c-a4ff13d3b414", // membershipUuid
  "membership.memberNumber" : "M-9000300",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2432,
  "valueDate" : "2002-02-17",
  "reference" : "sign 2002-02-07",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

Contact: Christian Fuchs - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Blumenstraße 234",
    "zipcode" : "30159",
    "city" : "Hannover",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 171 3920060"
  },
  "emailAddresses" : {
    "main" : "christian-fuchs@example.net"
  }
}
EOF
=> status: 201 CREATED 298d3f13-0e49-4962-ae5a-a1b15f46eda2

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	generalversammlung
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER generalversammlung: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
  "holder.uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
  "contact.uuid" : "298d3f13-0e49-4962-ae5a-a1b15f46eda2" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 7669ce05-3f4e-4c32-9e2d-fd5ff2fe7001

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/7669ce05-3f4e-4c32-9e2d-fd5ff2fe7001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7669ce05-3f4e-4c32-9e2d-fd5ff2fe7001",
  "anchor" : {
    "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "298d3f13-0e49-4962-ae5a-a1b15f46eda2", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	members-announce
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
  "holder.uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
  "contact.uuid" : "298d3f13-0e49-4962-ae5a-a1b15f46eda2" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 3ab0097f-94e9-48fd-aa49-14208681ce2b

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/3ab0097f-94e9-48fd-aa49-14208681ce2b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "3ab0097f-94e9-48fd-aa49-14208681ce2b",
  "anchor" : {
    "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "298d3f13-0e49-4962-ae5a-a1b15f46eda2", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	customers-announce
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
  "holder.uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
  "contact.uuid" : "298d3f13-0e49-4962-ae5a-a1b15f46eda2" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED dba7a77e-5832-460a-a872-0f9cfef005fb

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/dba7a77e-5832-460a-a872-0f9cfef005fb" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "dba7a77e-5832-460a-a872-0f9cfef005fb",
  "anchor" : {
    "uuid" : "38a84fde-b84d-417e-b06d-3d3801ff7515", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "01954c48-1128-4af2-9789-2ce653b4063a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "298d3f13-0e49-4962-ae5a-a1b15f46eda2", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Create Partner => Partner: P-90004 - Schäfer Elektro GmbH

Properties

Given

name	value
partnerNumber	P-90004
personType	LEGAL_PERSON
contactCaption	Schäfer Elektro GmbH - Hauptkontakt (P-90004)
postalAddress	“name”: “Buchhaltung”, “street”: “Veilchenweg 528”, “zipcode”: “44135”, “city”: “Dortmund”, “country”: “Germany”
officePhoneNumber	+49 176 04069082
emailAddress	info@schaefer-elektro-gmbh.example.org
tradeName	Schäfer Elektro GmbH
registrationOffice	Registergericht Dortmund
registrationNumber	619312

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Schäfer Elektro GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Schäfer Elektro GmbH"
}
EOF
=> status: 201 CREATED fd97d39c-95eb-4899-be37-2371689da574

Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Veilchenweg 528",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069082"
  },
  "emailAddresses" : {
    "main" : "info@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 461f128c-70fc-4d01-9157-f81be7fa4323

Create Partner: P-90004 - Schäfer Elektro GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90004",
  "partnerRel" : {
    "anchor.uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "holder.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "contact.uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323" // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
  },
  "details" : {
    "registrationOffice" : "Registergericht Dortmund",
    "registrationNumber" : "619312"
  }
}
EOF
=> status: 201 CREATED 2ea42fab-5912-4ecf-add9-0fbf8c43f3da

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Sch%C3%A4fer+Elektro+GmbH+-+Hauptkontakt+%28P-90004%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
  "anchor" : {
    "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
    "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Veilchenweg 528",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "info@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069082"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Jana Schäfer - Vertretung (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	REPRESENTATIVE
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - Vertretung (P-90004)
postalAddress	“street”: “Schulstraße 334”, “zipcode”: “34117”, “city”: “Kassel”, “country”: “Germany”
phoneNumber	+49 176 04069020
emailAddress	jana-schaefer@schaefer-elektro-gmbh.example.org

Person: Jana Schäfer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schäfer",
  "givenName" : "Jana"
}
EOF
=> status: 201 CREATED 34325c7c-0d18-49f0-8b56-bd927e094ca7

Contact: Jana Schäfer - Vertretung (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Jana Schäfer - Vertretung (P-90004)",
  "postalAddress" : {
    "street" : "Schulstraße 334",
    "zipcode" : "34117",
    "city" : "Kassel",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069020"
  },
  "emailAddresses" : {
    "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 94c9f355-332c-42cf-8235-4129b77cbd40

Create REPRESENTATIVE: Jana Schäfer - Vertretung (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "34325c7c-0d18-49f0-8b56-bd927e094ca7", // Person: Jana Schäfer
  "contact.uuid" : "94c9f355-332c-42cf-8235-4129b77cbd40" // Contact: Jana Schäfer - Vertretung (P-90004)
}
EOF
=> status: 201 CREATED a2b5042f-62ff-48a2-9093-af8e99e5baa9

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/a2b5042f-62ff-48a2-9093-af8e99e5baa9" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a2b5042f-62ff-48a2-9093-af8e99e5baa9",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "34325c7c-0d18-49f0-8b56-bd927e094ca7", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "94c9f355-332c-42cf-8235-4129b77cbd40", // Contact: Jana Schäfer - Vertretung (P-90004)
    "caption" : "Jana Schäfer - Vertretung (P-90004)",
    "postalAddress" : {
      "zipcode" : "34117",
      "country" : "Germany",
      "city" : "Kassel",
      "street" : "Schulstraße 334"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069020"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Claudia Schmitt - Technik (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	OPERATIONS
holderGivenName	Claudia
holderFamilyName	Schmitt
contactCaption	Claudia Schmitt - Technik (P-90004)
postalAddress	“street”: “Heideweg 201”, “zipcode”: “60311”, “city”: “Frankfurt am Main”, “country”: “Germany”
phoneNumber	+49 69 90009159
emailAddress	claudia-schmitt@schaefer-elektro-gmbh.example.org

Person: Claudia Schmitt

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schmitt",
  "givenName" : "Claudia"
}
EOF
=> status: 201 CREATED 8c6a7460-f0a1-4ae5-a5d7-236e254f2e2a

Contact: Claudia Schmitt - Technik (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Claudia Schmitt - Technik (P-90004)",
  "postalAddress" : {
    "street" : "Heideweg 201",
    "zipcode" : "60311",
    "city" : "Frankfurt am Main",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 69 90009159"
  },
  "emailAddresses" : {
    "main" : "claudia-schmitt@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 3fe64e39-2f10-4a20-9568-60f4fef90af0

Create OPERATIONS: Claudia Schmitt - Technik (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "8c6a7460-f0a1-4ae5-a5d7-236e254f2e2a", // Person: Claudia Schmitt
  "contact.uuid" : "3fe64e39-2f10-4a20-9568-60f4fef90af0" // Contact: Claudia Schmitt - Technik (P-90004)
}
EOF
=> status: 201 CREATED 83f91343-6caf-4f1c-8a24-06b024d48f1b

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/83f91343-6caf-4f1c-8a24-06b024d48f1b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "83f91343-6caf-4f1c-8a24-06b024d48f1b",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "8c6a7460-f0a1-4ae5-a5d7-236e254f2e2a", // Person: Claudia Schmitt
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Claudia",
    "familyName" : "Schmitt"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "3fe64e39-2f10-4a20-9568-60f4fef90af0", // Contact: Claudia Schmitt - Technik (P-90004)
    "caption" : "Claudia Schmitt - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "60311",
      "country" : "Germany",
      "city" : "Frankfurt am Main",
      "street" : "Heideweg 201"
    },
    "emailAddresses" : {
      "main" : "claudia-schmitt@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 69 90009159"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aaf
bankAccountHolder	Schäfer Elektro GmbH (P-90004/0)
iban	DE18990100000374198599
bic	DEMSDEH0
billingContactCaption	Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
billingContactEmailAddress	rechnung0@schaefer-elektro-gmbh.example.org

BankAccount: Schäfer Elektro GmbH (P-90004/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Schäfer Elektro GmbH (P-90004/0)",
  "iban" : "DE18990100000374198599",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 81b96f25-8f07-4a9d-8bbe-3052a2581718

Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
  "emailAddresses" : {
    "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED ef731586-6f5a-4bea-a027-c1c2afd2e984

Create Debitor: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "holder.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "contact.uuid" : "ef731586-6f5a-4bea-a027-c1c2afd2e984" // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "81b96f25-8f07-4a9d-8bbe-3052a2581718", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
  "defaultPrefix" : "aaf"
}
EOF
=> status: 201 CREATED e8746fc0-20bd-4b68-8b26-82b2ed2a3353

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/e8746fc0-20bd-4b68-8b26-82b2ed2a3353" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e8746fc0-20bd-4b68-8b26-82b2ed2a3353",
  "debitorRel" : {
    "uuid" : "74eb0829-eeb2-4da7-8415-da56e17a9e1d",
    "anchor" : {
      "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "ef731586-6f5a-4bea-a027-c1c2afd2e984", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
      "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000400",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da",
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "81b96f25-8f07-4a9d-8bbe-3052a2581718", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
    "holder" : "Schäfer Elektro GmbH (P-90004/0)",
    "iban" : "DE18990100000374198599",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aaf"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000400-aktuell

Properties

Given

name	value
debitorNumber	D-9000400
mandateReference	D-9000400-aktuell
bankAccountHolder	Schäfer Elektro GmbH (P-90004/0/aktuell)
iban	DE13990400000527372297
bic	DEMDDEB0
agreement	2020-07-13
validFrom	2020-07-27

Debitor of D-9000400-aktuell

HTTP GET "/api/hs/office/debitors/D-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e8746fc0-20bd-4b68-8b26-82b2ed2a3353",
  "debitorRel" : {
    "uuid" : "74eb0829-eeb2-4da7-8415-da56e17a9e1d",
    "anchor" : {
      "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "ef731586-6f5a-4bea-a027-c1c2afd2e984", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
      "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000400",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da",
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "81b96f25-8f07-4a9d-8bbe-3052a2581718", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
    "holder" : "Schäfer Elektro GmbH (P-90004/0)",
    "iban" : "DE18990100000374198599",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aaf"
}

BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Schäfer Elektro GmbH (P-90004/0/aktuell)",
  "iban" : "DE13990400000527372297",
  "bic" : "DEMDDEB0"
}
EOF
=> status: 201 CREATED eb9e05c0-4157-4c41-b1cf-b35a5fe42ab5

Create SEPA-Mandat: D-9000400-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "e8746fc0-20bd-4b68-8b26-82b2ed2a3353", // Debitor of D-9000400-aktuell
  "bankAccount.uuid" : "eb9e05c0-4157-4c41-b1cf-b35a5fe42ab5", // BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)
  "reference" : "D-9000400-aktuell",
  "agreement" : "2020-07-13",
  "validFrom" : "2020-07-27"
}
EOF
=> status: 201 CREATED 7cd294ee-b160-41d7-89c7-d0ce8ff5503e

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/7cd294ee-b160-41d7-89c7-d0ce8ff5503e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7cd294ee-b160-41d7-89c7-d0ce8ff5503e",
  "debitor" : {
    "uuid" : "e8746fc0-20bd-4b68-8b26-82b2ed2a3353", // Debitor of D-9000400-aktuell
    "debitorRel" : {
      "uuid" : "74eb0829-eeb2-4da7-8415-da56e17a9e1d",
      "anchor" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "ef731586-6f5a-4bea-a027-c1c2afd2e984", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
        "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000400",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da",
      "partnerNumber" : "P-90004",
      "partnerRel" : {
        "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
        "anchor" : {
          "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Schäfer Elektro GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
          "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
          "postalAddress" : {
            "zipcode" : "44135",
            "country" : "Germany",
            "city" : "Dortmund",
            "street" : "Veilchenweg 528",
            "name" : "Buchhaltung"
          },
          "emailAddresses" : {
            "main" : "info@schaefer-elektro-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 176 04069082"
          }
        }
      },
      "details" : {
        "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
        "registrationOffice" : "Registergericht Dortmund",
        "registrationNumber" : "619312",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "81b96f25-8f07-4a9d-8bbe-3052a2581718", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
      "holder" : "Schäfer Elektro GmbH (P-90004/0)",
      "iban" : "DE18990100000374198599",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aaf"
  },
  "bankAccount" : {
    "uuid" : "eb9e05c0-4157-4c41-b1cf-b35a5fe42ab5", // BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)
    "holder" : "Schäfer Elektro GmbH (P-90004/0/aktuell)",
    "iban" : "DE13990400000527372297",
    "bic" : "DEMDDEB0"
  },
  "reference" : "D-9000400-aktuell",
  "agreement" : "2020-07-13",
  "validFrom" : "2020-07-27",
  "validTo" : null
}

UseCase Create Membership => Membership: Schäfer Elektro GmbH

Properties

Given

name	value
partnerNumber	P-90004
validFrom	2005-01-22
membershipFeeBillable	true

Partner: P-90004

HTTP GET "/api/hs/office/partners/P-90004" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da",
  "partnerNumber" : "P-90004",
  "partnerRel" : {
    "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
    "anchor" : {
      "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
      "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
      "postalAddress" : {
        "zipcode" : "44135",
        "country" : "Germany",
        "city" : "Dortmund",
        "street" : "Veilchenweg 528",
        "name" : "Buchhaltung"
      },
      "emailAddresses" : {
        "main" : "info@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 176 04069082"
      }
    }
  },
  "details" : {
    "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
    "registrationOffice" : "Registergericht Dortmund",
    "registrationNumber" : "619312",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Schäfer Elektro GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da", // Partner: P-90004
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2005-01-22",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED abc11a67-b027-49e3-a4ea-e43dfbac0a12

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/abc11a67-b027-49e3-a4ea-e43dfbac0a12" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12",
  "partner" : {
    "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000400
reference	sign 2005-01-22
shareCount	24
comment	initial shares on joining
transactionDate	2005-01-22

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12",
  "partner" : {
    "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2005-01-22",
  "shareCount" : 24,
  "comment" : "initial shares on joining",
  "valueDate" : "2005-01-22"
}
EOF
=> status: 201 CREATED f1705690-457c-44ea-894f-1d93b4007367

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/f1705690-457c-44ea-894f-1d93b4007367" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f1705690-457c-44ea-894f-1d93b4007367",
  "membership.uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 24,
  "valueDate" : "2005-01-22",
  "reference" : "sign 2005-01-22",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000400
reference	sign 2005-01-22
assetValue	1536
comment	deposit for initial shares
transactionDate	2005-02-06

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12", // membershipUuid
  "partner" : {
    "uuid" : "2ea42fab-5912-4ecf-add9-0fbf8c43f3da", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "022642a0-feb7-4ced-84ea-6f749f277158",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2005-01-22",
  "assetValue" : 1536,
  "comment" : "deposit for initial shares",
  "valueDate" : "2005-02-06"
}
EOF
=> status: 201 CREATED be1e8d68-cbca-4bab-82b8-07d0fa289826

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/be1e8d68-cbca-4bab-82b8-07d0fa289826" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "be1e8d68-cbca-4bab-82b8-07d0fa289826",
  "membership.uuid" : "abc11a67-b027-49e3-a4ea-e43dfbac0a12", // membershipUuid
  "membership.memberNumber" : "M-9000400",
  "transactionType" : "DEPOSIT",
  "assetValue" : 1536,
  "valueDate" : "2005-02-06",
  "reference" : "sign 2005-01-22",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Jana Schäfer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	generalversammlung
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - Vertretung (P-90004)

Create SUBSCRIBER generalversammlung: Jana Schäfer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "34325c7c-0d18-49f0-8b56-bd927e094ca7", // Person: Jana Schäfer
  "contact.uuid" : "94c9f355-332c-42cf-8235-4129b77cbd40" // Contact: Jana Schäfer - Vertretung (P-90004)
}
EOF
=> status: 201 CREATED 27e13aef-24e5-45dc-a085-13d928ac58b9

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/27e13aef-24e5-45dc-a085-13d928ac58b9" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "27e13aef-24e5-45dc-a085-13d928ac58b9",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "34325c7c-0d18-49f0-8b56-bd927e094ca7", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "94c9f355-332c-42cf-8235-4129b77cbd40", // Contact: Jana Schäfer - Vertretung (P-90004)
    "caption" : "Jana Schäfer - Vertretung (P-90004)",
    "postalAddress" : {
      "zipcode" : "34117",
      "country" : "Germany",
      "city" : "Kassel",
      "street" : "Schulstraße 334"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069020"
    }
  }
}

Contact: Jana Schäfer - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Jana Schäfer - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Mühlenkamp 757",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 172 9973186"
  },
  "emailAddresses" : {
    "main" : "jana-schaefer@example.net"
  }
}
EOF
=> status: 201 CREATED 40abeb32-f447-431c-bfca-4d9cac127ec0

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Jana Schäfer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	members-announce
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Jana Schäfer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "34325c7c-0d18-49f0-8b56-bd927e094ca7", // Person: Jana Schäfer
  "contact.uuid" : "40abeb32-f447-431c-bfca-4d9cac127ec0" // Contact: Jana Schäfer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 4a5b3e17-aeaf-4f73-93e5-ab6b5ca7fd93

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/4a5b3e17-aeaf-4f73-93e5-ab6b5ca7fd93" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "4a5b3e17-aeaf-4f73-93e5-ab6b5ca7fd93",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "34325c7c-0d18-49f0-8b56-bd927e094ca7", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "40abeb32-f447-431c-bfca-4d9cac127ec0", // Contact: Jana Schäfer - private Mailinglisten-Adresse
    "caption" : "Jana Schäfer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Mühlenkamp 757"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 172 9973186"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Michael Fischer - Technik (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	OPERATIONS
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)
postalAddress	“name”: “Buchhaltung”, “street”: “Schlehenweg 867”, “zipcode”: “33602”, “city”: “Bielefeld”, “country”: “Germany”
phoneNumber	+49 176 04069045
emailAddress	michael-fischer@schaefer-elektro-gmbh.example.org

Person: Michael Fischer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fischer",
  "givenName" : "Michael"
}
EOF
=> status: 201 CREATED dac8c95c-b91a-4986-af91-6d19a75d2310

Contact: Michael Fischer - Technik (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Michael Fischer - Technik (P-90004)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Schlehenweg 867",
    "zipcode" : "33602",
    "city" : "Bielefeld",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069045"
  },
  "emailAddresses" : {
    "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED b81f6f59-6010-42b9-9a39-5cc4cd3e42e8

Create OPERATIONS: Michael Fischer - Technik (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "dac8c95c-b91a-4986-af91-6d19a75d2310", // Person: Michael Fischer
  "contact.uuid" : "b81f6f59-6010-42b9-9a39-5cc4cd3e42e8" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 7c7143c1-4cb6-4fc8-b1c0-96c33da4b5b6

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/7c7143c1-4cb6-4fc8-b1c0-96c33da4b5b6" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7c7143c1-4cb6-4fc8-b1c0-96c33da4b5b6",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "dac8c95c-b91a-4986-af91-6d19a75d2310", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "b81f6f59-6010-42b9-9a39-5cc4cd3e42e8", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Michael Fischer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	operations-announce
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)

Create SUBSCRIBER operations-announce: Michael Fischer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "dac8c95c-b91a-4986-af91-6d19a75d2310", // Person: Michael Fischer
  "contact.uuid" : "b81f6f59-6010-42b9-9a39-5cc4cd3e42e8" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED d0385369-30fd-4549-9053-7e32172c7626

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/d0385369-30fd-4549-9053-7e32172c7626" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d0385369-30fd-4549-9053-7e32172c7626",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "dac8c95c-b91a-4986-af91-6d19a75d2310", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "b81f6f59-6010-42b9-9a39-5cc4cd3e42e8", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-discussion: Michael Fischer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	operations-discussion
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)

Create SUBSCRIBER operations-discussion: Michael Fischer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "anchor.uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "dac8c95c-b91a-4986-af91-6d19a75d2310", // Person: Michael Fischer
  "contact.uuid" : "b81f6f59-6010-42b9-9a39-5cc4cd3e42e8" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 292d4edf-ca0d-4b93-98fc-2c82cb6dc87b

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/292d4edf-ca0d-4b93-98fc-2c82cb6dc87b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "292d4edf-ca0d-4b93-98fc-2c82cb6dc87b",
  "anchor" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "dac8c95c-b91a-4986-af91-6d19a75d2310", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "contact" : {
    "uuid" : "b81f6f59-6010-42b9-9a39-5cc4cd3e42e8", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

Query the most recently generated demo partner

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Sch%C3%A4fer+Elektro+GmbH+-+Hauptkontakt+%28P-90004%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "a2f49423-26fa-43c1-9e83-ec4c8e51103b",
  "anchor" : {
    "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "fd97d39c-95eb-4899-be37-2371689da574", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "461f128c-70fc-4d01-9157-f81be7fa4323", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
    "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Veilchenweg 528",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "info@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069082"
    }
  }
} ]

Verify the Showcase Cooperative Has Exactly One Membership

HTTP GET "/api/hs/office/memberships?partnerNumber=P-90000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "9cd29d80-7c77-4fb3-9772-03a0fbc69ba8",
  "partner" : {
    "uuid" : "5809a309-c582-4b08-b9a0-62236aa95d13", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "ec49e14a-9ecd-4499-b25e-62a1d5bf25fd",
      "anchor" : {
        "uuid" : "34d96c31-7002-41a6-83b4-08898defecd3", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "eced4afc-0085-4561-b74c-47e3aba0313d", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "c94cc771-699e-4b18-a2e5-17c7307d66c8", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "843b94b3-b59a-469a-9551-a74ba6cfee93",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
} ]

generated on 2026-08-10 01:38:05 for branch